ReadAsync(Byte[],Int32,Int32,CancellationToken) Method

Reads data into the application provided buffer asynchronously and advances the current position of the stream.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Overloads Overrides NotOverridable Function ReadAsync( _
   ByVal buffer() As Byte, _
   ByVal offset As Integer, _
   ByVal count As Integer, _
   ByVal cancellationToken As CancellationToken _
) As Task(Of Integer)

'Usage
 
Dim instance As TdStream
Dim buffer() As Byte
Dim offset As Integer
Dim count As Integer
Dim cancellationToken As CancellationToken
Dim value As Task(Of Integer)
 
value = instance.ReadAsync(buffer, offset, count, cancellationToken)

public override Task<int> ReadAsync( 
   byte[] buffer,
   int offset,
   int count,
   CancellationToken cancellationToken
)

public:
Task<int>^ ReadAsync( 
   array<byte>^ buffer,
   int offset,
   int count,
   CancellationToken cancellationToken
) override

Parameters

buffer: Specifies a Byte array to read data into.
offset: Specifies the location within the buffer to read data into.
count: Specifies the number of bytes to read into the buffer
cancellationToken: A Threading.CancellationToken used to indicate that the asynchronous operation should be canceled.

Return Value

Returns the number of bytes read from the Advanced SQL Engine and written into the . The number will be equal or less than .

Exceptions

Exception	Description
System.ArgumentNullException	buffer is null.
System.ArgumentOutOfRangeException	count or offset is negative or the sum of offset and count is larger than the buffer length.
System.InvalidOperationException	The TdConnection is closed.
System.ObjectDisposedException	The `TdStream` is closed / dispose.
TdException	The SQL Engine returned an error, or the .NET Data Provider for Teradata detected an error.

Remarks

The .NET Data Provider for Teradata reads the LOB from Teradata and transfers it to the application provided buffer.

Requirements

Target Platforms: Windows 8.1, Windows 10, Windows Server 2012 R2, Windows Server 2016, Windows Server 2019

Reference

TdStream Class
TdStream Members
Overload List